.\" Manpage for ridlc.
.\" Contact woodhead99@gmail.com to correct errors or typos.
.TH man 1 "16 Jun. 2022" "1.0" "rpc-frmwrk user manuals"
.SH NAME
ridlc \- ridl compiler to generate skelton code for rpc-frmwrk.
.SH SYNOPSIS
ridlc [options] <ridl file>
.SH DESCRIPTION
.BR ridlc
parses the given ridl file and generate a set of skelton code in the
specified language, Python or C++ at present.
.SH OPTIONS
.TP
.BR \-I " "\fIpath\fR
To specify the path to search for the included files. This option can repeat many times.
.TP
.BR \-O " "\fIpath\fR
To specify the path to store the generated files.
.TP
.BR \-p " "
To generate the Python skelton files.
.TP
.BR \-j " "
To generate the Java skelton files.
.TP
.BR \-f " "
To generate the 'skelton files with 'rpcfs' support. C++ or Python at present.
.TP
.BR \-P " "\fIprefix\fR
To specify the prefix of the Java package. This option is only effective for Java.
.TP
.BR \-l " "
To build a shared library instead of a program. This option works for programms of C++ skelton
.TP
.BR \-L " "\fIlang\fR
To output the 'README.md' file in the specified language <lang>. Currently we support
two languages, "cn" as Chinese, and "en" as English.
.TP
.BR \-s " "
To generate the skelton code for `RPC-Over-Stream`, a new architecture with 99% of communication over stream channels.
.TP
.BR \-b " "
To generate the skelton code with a built-in `rpcrouter`, which has lower latency and higher throughput than stand-alone rpcrouter.


.SH SEE ALSO
ridl(7), rpcrouter(1)
.SH BUGS
No known bugs.
.SH AUTHOR
zhiming <woodhead99@gmail.com>

